home *** CD-ROM | disk | FTP | other *** search
/ ShareWare OnLine 2 / ShareWare OnLine Volume 2 (CMS Software)(1993).iso / os2 / l2_20.zip / L2.DOC next >
Text File  |  1993-01-17  |  13KB  |  274 lines
  1.  
  2. ==============================================================================
  3.  
  4.                                L2 Version 2.0
  5.                           Copyright (c) 1992, 1993
  6.  
  7.                        An OS/2 2.0 file-viewer utility
  8.  
  9.                              SANSoft Development
  10.                               4971 Pegasus Ct.
  11.                              Hilliard, OH  43026
  12.                          Voice-mail: (614) 898-2675
  13.  
  14. ==============================================================================
  15.  
  16.  
  17. Description
  18. -----------
  19. L2 is a text file-viewer utility created for OS/2 2.0 developers and users.
  20. It is developed entirely as a 32-bit application (save the text-mode
  21. interface, which IBM left as 16-bit). Multiple files may be specified on the
  22. command line (although wildcards are not supported), and there is no
  23. restriction as to the maximum line length of a file. In addition to the
  24. standard features of a file-viewer utility, L2 incorporates intelligent tab
  25. expansion, multiple text modes, jumping to a specific line number, setting
  26. and retrieving of bookmarks, and regular expression searches.  Also, because
  27. L2 loads the file to be viewed entirely into memory, scrolling, jumping to
  28. specific or saved locations, and text searches are extremely fast.
  29.  
  30.  
  31. Release 2.0 Notes
  32. -----------------
  33. Release 2.0 of L2 incorporates several new features, including wildcard
  34. filename expansion and a file-selection list. Command-line arguments passed
  35. to L2 which have wildcards ('*' and '?') are expanded into full file names.
  36. Arguments without wildcards are left as-is. The F6 and Shift-F6 keys move
  37. forward and backward through the expanded list of files. The Ctrl-F6 key
  38. brings up a list of all of the expanded file names, with the currently listed
  39. file hilited. The desired file may be hilited, and when <Enter> is pressed,
  40. that file will be loaded.
  41.  
  42. If there is a problem loading the next/previous/selected file, a message
  43. is displayed, there is a short pause, and the next file in the list is
  44. loaded. If L2 gets through the entire list of files without being able to
  45. load any of them, it will exit.
  46.  
  47. To work with this capability, the file-search criterion remain across files.
  48. Thus, if a search is performed on one file and then a new file is selected,
  49. only the 'A' key needs pressed to repeat that search from the top of the new
  50. file. The <Esc> key exits L2 altogether.
  51.  
  52. Also, bookmarks maintain the file in which they are set. Thus, if 5 files
  53. are in the file list and bookmark 2 is set in file 3, the specified location 
  54. in file 3 will be returned to were bookmark 2 to be retrieved from file 1.
  55.  
  56.  
  57. Features of L2
  58. --------------
  59. L2 uses "intelligent tab expansion": most text editors allow a tab width to
  60. be set. When <Tab> is pressed, the cursor goes to the next multiple of that
  61. tab stop on the current line. For example, if the tab width is 4, tab stops
  62. would be at columns 1, 5, 9, 13, etc. If the cursor is in column 10 and <Tab>
  63. is pressed, the cursor goes to column 13, where the next character will be
  64. placed.  Editors operate this way so that source code will have correct
  65. indentation.  Assuming that the tabs are saved in the file, most file-viewers
  66. simply display the character after a tab after moving the tab-width number of
  67. places to the right. In the previous example, with a tab-width of 4 and a tab
  68. at column 10, the standard file-viewer would display the next character at
  69. column 14 rather than 13. Thus columns are not aligned correctly, and the
  70. file doesn't look the same in the file-viewer as in the editor. L2 corrects
  71. this problem by using the tab width for locating tab stops the same way that
  72. an editor does.
  73.  
  74. L2 supports up to 15 video modes, depending on hardware. Its default mode is
  75. 80x30 (720x480). When cycling through video modes, L2 stops at the next valid
  76. mode. Also, L2 supports up to 16 BACKGROUND colors, as well as the standard
  77. 16 foreground colors, again, depending on hardware.
  78.  
  79. Specific line numbers may be jumped to. Also, bookmarks may be set and
  80. retrieved. This is useful when examining source code and jumping from one
  81. function to another and back, etc.
  82.  
  83. L2 supports regular expression searches, so that complex search expressions
  84. may be entered and acted on. This goes beyond the capabilities of most file
  85. viewers.
  86.  
  87. L2 is strictly for viewing text (ASCII) files, with lines delimited by CR/LF
  88. combinations. Attempting to view non-text files with L2 will yield
  89. unpredictable results.
  90.  
  91.  
  92. Using L2
  93. --------
  94. First, copy L2.EXE to a directory that is in your PATH statement. Then, to
  95. run L2, simply type L2 at an OS/2 2.0 full-screen or windowed prompt (L2 runs
  96. much better in full-screen mode), followed by 1 or more file names, and then
  97. press <Enter>:
  98.  
  99.   L2 filenam1.ext [filenam2.ext [filenam3.ext...]] <Enter>
  100.  
  101. If you run L2 with no file names, a message is displayed as to the usage.
  102.  
  103. L2 will be started in its currently configured state. Initially, that is 80
  104. column by 30 row (720x480 pixels), with default colors, tab expansion on, and
  105. a tab width of 3. There is a means to change these, described later.
  106.  
  107. L2 comes up with the top of the file displayed starting on the second row,
  108. continuing to the next to the bottom row. The top row is an informational /
  109. status line as shown below:
  110.  
  111.  FILENAME.EXT  9,999,999 9,999,999  +999,999   999,999      MM/DD/YY  HH:MM:SS
  112.       │            │         │          │         │            │         │
  113.   file name      line #   # lines    column   file size    file date file time
  114.  
  115. The column offset area is only displayed when not in the leftmost column.
  116. Also, if the file size exceeds 1,000,000 bytes, it will be displayed in terms
  117. of the number of kilobytes (e.g. 1,354K).
  118.  
  119. The bottom line on the display is for messages and text input. "Top of file"
  120. and "End of file" are examples of the messages displayed there. Text to be
  121. input includes the text for searches and line numbers for jumping.
  122.  
  123. Pressing <F1> brings up a simple help screen describing available keys and
  124. their functionality.  Pressing the Escape key (<Esc>) exits the currently
  125. displayed file.  If another file is specified on the command line, that file
  126. will be displayed; otherwise, control is returned to the full-screen or
  127. windowed session.
  128.  
  129.  
  130. Navigating L2
  131. -------------
  132. The standard navigation keys are used to move throughout the file. These
  133. include:
  134.  
  135.   Cursor keys ()    - line/column at a time scrolling,
  136.   Ctrl-Left, Ctrl-Right - tab-width at a time horizontal scrolling
  137.   PgUp, PgDn            - page up and page down scrolling
  138.   Home                  - top of file, stay in current column
  139.   Ctrl-Home             - top of file, column 1
  140.   Backspace             - go to column 1
  141.   End                   - end of file, column 1
  142.  
  143. Other navigation keys include:
  144.  
  145.   'G' key               - prompted for a line number; go to that line
  146.   '0' - '9' keys        - set bookmarks 0 through 9
  147.   Shift '0' - '9' keys  - retrieve bookmarks 0 through 9
  148.  
  149.  
  150. Searching in L2
  151. ---------------
  152. There are three types of searches in L2: case-sensitive text search,
  153. case-insensitive text search, and regular expression search. To perform a
  154. search, press:
  155.  
  156.   'F' key               - perform a case-insensitive search; enter up to 60
  157.                           characters to search for; escape or 0 length search
  158.                           text cancels the search
  159.   'S' key               - case-sensitive search, up to 60 characters
  160.   'R' key               - regular expression search, up to 60 characters in
  161.                           the expression (although the found text may be
  162.                           longer)
  163.   'A' key               - repeat the last search from the last found text
  164.  
  165. All new searches (i.e., those begun with the 'F', 'S', or 'R' keys) begin at
  166. the top of the file. If the text is found, L2 will move to the line
  167. containing the text and hilite the text.  If the text is not found, a message
  168. will be displayed at the bottom of the screen.  Pressing 'A' after getting a
  169. "Text not found..." message will begin the search again at the top of the
  170. file.
  171.  
  172. A repeated text search will begin at the first character after the previously
  173. found text. Regular expressions, however, are line-at-a-time searches;
  174. therefore, a repeated regular expression search will begin on the line after
  175. the line containing the previously found text.
  176.  
  177. The characters available for regular expression searches are:
  178.  
  179.   ^      - matches beginning of line
  180.   $      - matches end of line
  181.   .      - matches any character
  182.   \      - followed by a single character matches that character, except:
  183.   \b     - backspace
  184.   \s     - space
  185.   \t     - tab
  186.   \\     - backslash
  187.   []     - character class
  188.   [^...] - negative character class
  189.   *      - match 0 or more occurences of the preceding regular expression
  190.   |      - match expression before | or expression after |
  191.  
  192. Ranges of ASCII characters may be specified in character classes. For
  193. instance, [a-zA-Z0-9] matches any alphanumeric character. The characters * .
  194. ^ $ are not special characters within a character class.
  195.  
  196.  
  197. Configuring L2
  198. --------------
  199. There are several configurable items in L2, including tab expansion (on/off),
  200. tab width (2-8), screen colors (text, border, hilite, and help), and video
  201. mode. To modify these items, press:
  202.  
  203.   'T' key               - toggle tab expansion on/off
  204.   'W' key               - cycle the tab width from 2-8 spaces
  205.   'M' key               - cycle the video mode; there are 15 potential video
  206.                           modes, depending on the support your hardware
  207.                           provides
  208.   F2, Shift-F2          - background, foreground text colors
  209.   F3, Shift-F3          - background, foreground border colors
  210.   F4, Shift-F4          - background, foreground hilite colors (found text)
  211.   F5, Shift-F5          - background, foreground help colors
  212.  
  213.   Note: There are 16 available foreground AND background colors, assuming the
  214.         hardware supports it.
  215.  
  216. If any of the configurable items are changed, the changes WILL BE LOST if the 
  217. configuration is not saved. To save L2's configuration, press the <F10> key.  
  218. L2 maintains its configuration information in the L2.EXE file (this is done 
  219. to make loading L2 as fast as possible). Since OS/2 keeps the .EXE file open 
  220. in DENYWRITE mode while L2.EXE is running, L2 cannot save its configuration 
  221. to itelf; therefore L2 saves its configuration in a file called L2CLONE.EXE.  
  222. This file can then be renamed to L2.EXE after exiting L2 (to use the RENAME 
  223. command, L2.EXE must be deleted or renamed first). One advantage of this 
  224. approach is that you can create multiple copies of L2 for viewing different 
  225. file types, such as L2C.EXE for C files; L2ASM.EXE for assembler files; etc.  
  226. The configuration for each version could be appropriate to that file type.
  227.  
  228.  
  229. Registering L2
  230. --------------
  231. L2 was developed to support the author's responsibility of evaluating and 
  232. documenting a system with 400+ modules for which the source code was acquired 
  233. from a third-party company. It is distributed as shareware with the 
  234. confidence that it can help others as well. Your comments, suggestions, and 
  235. constructive criticisms are welcome. Please enclose them, along with the 
  236. $25.00 registration fee, addressed to:
  237.  
  238.     SANSoft Development
  239.     4971 Pegasus Ct.
  240.     Hilliard, OH  43026
  241.     Voice-mail: (614) 898-2675
  242.  
  243. Contact SANSoft Development for site licenses or volume purchases of SDE.
  244.  
  245. Thank you in advance for your support.
  246.  
  247.  
  248. Distributing L2
  249. ---------------
  250. SANSoft Development retains the sole right to sell L2; however, it may be
  251. distributed, provided:
  252.  
  253.   A. It is only distributed in its unmodified, archived form (L2.ZIP)
  254.   B. No attempt is made to profit from the distribution of L2 (a duplication
  255.      fee not to exceed $5.00 may be charge by recognized users' groups)
  256.  
  257.  
  258. Warranty/Disclaimer
  259. -------------------
  260. SANSoft Development makes no representations or warranties as to the 
  261. merchantibility or fitness of this product to a particular purpose. There is 
  262. no other warrenty, expressed or implied. SANSoft Development  will not be 
  263. liable for any special, incidental, consequential, indirect or similar 
  264. damages due to loss of data or any other reason, even if SANSoft or an agent 
  265. of SANSoft has been advised of the possibility of such damages. In no event 
  266. shall SANSoft Development's liability for any damages ever exceed the price 
  267. paid for the license to use the software, regardless of the form of the 
  268. claim. The person using the software bears all risk as to the quality and 
  269. performance of the software. Use of this package constitutes agreement on the 
  270. part of the user to this disclaimer.
  271.  
  272. ============================ E N D  O F  F I L E =============================
  273.  
  274.